<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>EntityHttpServletResponse xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/entitybus/util/http/EntityHttpServletResponse.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: EntityHttpServletResponse.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-utils/xref/org/sakaiproject/entitybus/util/http/EntityHttpServletResponse.html $</em>
<a name="4" href="#4">4</a>   <em> * EntityHttpServletResponse.java - entity-broker - Dec 24, 2008 4:01:15 PM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2.0</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski @ gmail.com) (aaronz @ vt.edu) (aaron @ caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.entitybus.util.http;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.io.ByteArrayOutputStream;
<a name="18" href="#18">18</a>  <strong>import</strong> java.io.IOException;
<a name="19" href="#19">19</a>  <strong>import</strong> java.io.OutputStreamWriter;
<a name="20" href="#20">20</a>  <strong>import</strong> java.io.PrintWriter;
<a name="21" href="#21">21</a>  <strong>import</strong> java.io.UnsupportedEncodingException;
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.ArrayList;
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.Collections;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.Iterator;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.List;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.Locale;
<a name="27" href="#27">27</a>  <strong>import</strong> java.util.Map;
<a name="28" href="#28">28</a>  <strong>import</strong> java.util.Set;
<a name="29" href="#29">29</a>  <strong>import</strong> java.util.Vector;
<a name="30" href="#30">30</a>  <strong>import</strong> java.util.concurrent.ConcurrentHashMap;
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>  <strong>import</strong> javax.servlet.ServletOutputStream;
<a name="33" href="#33">33</a>  <strong>import</strong> javax.servlet.http.Cookie;
<a name="34" href="#34">34</a>  <strong>import</strong> javax.servlet.http.HttpServletResponse;
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>  <strong>import</strong> org.azeckoski.reflectutils.map.ArrayOrderedMap;
<a name="37" href="#37">37</a>  
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>  <em>/**<em>*</em></em>
<a name="40" href="#40">40</a>  <em> * This is here to allow us to receive response data back which will not mess up an existing response</em>
<a name="41" href="#41">41</a>  <em> * object and to allow for mocking of responses,</em>
<a name="42" href="#42">42</a>  <em> * based on and built from the example in spring framework</em>
<a name="43" href="#43">43</a>  <em> * </em>
<a name="44" href="#44">44</a>  <em> * @author Aaron Zeckoski (azeckoski @ gmail.com)</em>
<a name="45" href="#45">45</a>  <em> */</em>
<a name="46" href="#46">46</a>  @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="47" href="#47">47</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/EntityHttpServletResponse.html">EntityHttpServletResponse</a> implements HttpServletResponse {
<a name="48" href="#48">48</a>  
<a name="49" href="#49">49</a>      <em>/**<em>*</em></em>
<a name="50" href="#50">50</a>  <em>     * Create a default response that is valid for testing</em>
<a name="51" href="#51">51</a>  <em>     */</em>
<a name="52" href="#52">52</a>      <strong>public</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/EntityHttpServletResponse.html">EntityHttpServletResponse</a>() {
<a name="53" href="#53">53</a>          <strong>this</strong>.content = <strong>new</strong> ByteArrayOutputStream(512);
<a name="54" href="#54">54</a>          <strong>this</strong>.outputStream = <strong>new</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/EntityServletOutputStream.html">EntityServletOutputStream</a>(content);
<a name="55" href="#55">55</a>          <strong>this</strong>.setLocale( Locale.getDefault() );
<a name="56" href="#56">56</a>      }
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>      <em>/**<em>*</em></em>
<a name="59" href="#59">59</a>  <em>     * Create a servlet response using the various values and codes stored in the given one,</em>
<a name="60" href="#60">60</a>  <em>     * makes copies mostly</em>
<a name="61" href="#61">61</a>  <em>     * @param response any valid response, cannot be null</em>
<a name="62" href="#62">62</a>  <em>     */</em>
<a name="63" href="#63">63</a>      <strong>public</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/EntityHttpServletResponse.html">EntityHttpServletResponse</a>(HttpServletResponse response) {
<a name="64" href="#64">64</a>          <strong>this</strong>.content = <strong>new</strong> ByteArrayOutputStream(512);
<a name="65" href="#65">65</a>          <strong>this</strong>.outputStream = <strong>new</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/EntityServletOutputStream.html">EntityServletOutputStream</a>(content);
<a name="66" href="#66">66</a>          <strong>if</strong> (response == <strong>null</strong>) {
<a name="67" href="#67">67</a>              <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"response to copy cannot be null"</span>);
<a name="68" href="#68">68</a>          }
<a name="69" href="#69">69</a>          <strong>this</strong>.setBufferSize( response.getBufferSize() );
<a name="70" href="#70">70</a>          <strong>if</strong> (response.getContentType() != <strong>null</strong>) {
<a name="71" href="#71">71</a>              <strong>this</strong>.setContentType( response.getContentType() );
<a name="72" href="#72">72</a>          }
<a name="73" href="#73">73</a>          <strong>this</strong>.setLocale( response.getLocale() );
<a name="74" href="#74">74</a>      }
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> DEFAULT_SERVER_PORT = 80;
<a name="77" href="#77">77</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String CHARSET_PREFIX = <span class="string">"charset="</span>;
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>      <strong>public</strong> ConcurrentHashMap&lt;String, Vector&lt;String>> headers = <strong>new</strong> ConcurrentHashMap&lt;String, Vector&lt;String>>();
<a name="80" href="#80">80</a>      <strong>public</strong> Vector&lt;Cookie> cookies = <strong>new</strong> Vector&lt;Cookie>();
<a name="81" href="#81">81</a>  
<a name="82" href="#82">82</a>      <strong>private</strong> <strong>boolean</strong> contentAccessed = false; <em class="comment">// for debugging and tracking</em>
<a name="83" href="#83">83</a>      <strong>private</strong> <strong>final</strong> ByteArrayOutputStream content;
<a name="84" href="#84">84</a>      <strong>private</strong> <strong>final</strong> ServletOutputStream outputStream;
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>      <strong>private</strong> <strong>boolean</strong> outputStreamAccessAllowed = <strong>true</strong>;
<a name="87" href="#87">87</a>      <strong>private</strong> <strong>boolean</strong> writerAccessAllowed = <strong>true</strong>;
<a name="88" href="#88">88</a>      <strong>private</strong> String characterEncoding = <span class="string">"UTF-8"</span>;
<a name="89" href="#89">89</a>      <strong>private</strong> PrintWriter writer;
<a name="90" href="#90">90</a>      <strong>private</strong> <strong>int</strong> contentLength = 0;
<a name="91" href="#91">91</a>      <strong>private</strong> String contentType;
<a name="92" href="#92">92</a>      <strong>private</strong> <strong>int</strong> bufferSize = 4096;
<a name="93" href="#93">93</a>      <strong>private</strong> <strong>boolean</strong> committed;
<a name="94" href="#94">94</a>  
<a name="95" href="#95">95</a>      <strong>private</strong> Locale locale = Locale.getDefault();
<a name="96" href="#96">96</a>      <strong>private</strong> <strong>int</strong> status = HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>      <strong>private</strong> String errorMessage;
<a name="99" href="#99">99</a>      <strong>private</strong> String redirectedUrl;
<a name="100" href="#100">100</a>     <strong>private</strong> String forwardedUrl;
<a name="101" href="#101">101</a>     <strong>private</strong> String includedUrl;
<a name="102" href="#102">102</a> 
<a name="103" href="#103">103</a>     
<a name="104" href="#104">104</a>     <em class="comment">// methods for testing only</em>
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>     <strong>public</strong> <strong>void</strong> setForwardedUrl(String forwardedUrl) {
<a name="107" href="#107">107</a>         <strong>this</strong>.forwardedUrl = forwardedUrl;
<a name="108" href="#108">108</a>         <strong>this</strong>.status = HttpServletResponse.SC_OK;
<a name="109" href="#109">109</a>     }
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>     <strong>public</strong> String getForwardedUrl() {
<a name="112" href="#112">112</a>         <strong>return</strong> <strong>this</strong>.forwardedUrl;
<a name="113" href="#113">113</a>     }
<a name="114" href="#114">114</a> 
<a name="115" href="#115">115</a>     <strong>public</strong> <strong>void</strong> setIncludedUrl(String includedUrl) {
<a name="116" href="#116">116</a>         <strong>this</strong>.includedUrl = includedUrl;
<a name="117" href="#117">117</a>         <strong>this</strong>.status = HttpServletResponse.SC_OK;
<a name="118" href="#118">118</a>     }
<a name="119" href="#119">119</a> 
<a name="120" href="#120">120</a>     <strong>public</strong> String getIncludedUrl() {
<a name="121" href="#121">121</a>         <strong>return</strong> <strong>this</strong>.includedUrl;
<a name="122" href="#122">122</a>     }
<a name="123" href="#123">123</a> 
<a name="124" href="#124">124</a>     <em class="comment">// Other methods</em>
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a>     <em>/**<em>*</em></em>
<a name="127" href="#127">127</a> <em>     * Set whether {@link #getOutputStream()} access is allowed.</em>
<a name="128" href="#128">128</a> <em>     * &lt;p>Default is &lt;code>true&lt;/code>.</em>
<a name="129" href="#129">129</a> <em>     */</em>
<a name="130" href="#130">130</a>     <strong>public</strong> <strong>void</strong> setOutputStreamAccessAllowed(<strong>boolean</strong> outputStreamAccessAllowed) {
<a name="131" href="#131">131</a>         <strong>this</strong>.outputStreamAccessAllowed = outputStreamAccessAllowed;
<a name="132" href="#132">132</a>     }
<a name="133" href="#133">133</a> 
<a name="134" href="#134">134</a>     <em>/**<em>*</em></em>
<a name="135" href="#135">135</a> <em>     * Return whether {@link #getOutputStream()} access is allowed.</em>
<a name="136" href="#136">136</a> <em>     */</em>
<a name="137" href="#137">137</a>     <strong>public</strong> <strong>boolean</strong> isOutputStreamAccessAllowed() {
<a name="138" href="#138">138</a>         <strong>return</strong> <strong>this</strong>.outputStreamAccessAllowed;
<a name="139" href="#139">139</a>     }
<a name="140" href="#140">140</a> 
<a name="141" href="#141">141</a>     <em>/**<em>*</em></em>
<a name="142" href="#142">142</a> <em>     * Set whether {@link #getWriter()} access is allowed.</em>
<a name="143" href="#143">143</a> <em>     * &lt;p>Default is &lt;code>true&lt;/code>.</em>
<a name="144" href="#144">144</a> <em>     */</em>
<a name="145" href="#145">145</a>     <strong>public</strong> <strong>void</strong> setWriterAccessAllowed(<strong>boolean</strong> writerAccessAllowed) {
<a name="146" href="#146">146</a>         <strong>this</strong>.writerAccessAllowed = writerAccessAllowed;
<a name="147" href="#147">147</a>     }
<a name="148" href="#148">148</a> 
<a name="149" href="#149">149</a>     <em>/**<em>*</em></em>
<a name="150" href="#150">150</a> <em>     * Return whether {@link #getOutputStream()} access is allowed.</em>
<a name="151" href="#151">151</a> <em>     */</em>
<a name="152" href="#152">152</a>     <strong>public</strong> <strong>boolean</strong> isWriterAccessAllowed() {
<a name="153" href="#153">153</a>         <strong>return</strong> <strong>this</strong>.writerAccessAllowed;
<a name="154" href="#154">154</a>     }
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="157" href="#157">157</a> <em class="comment">     * @see javax.servlet.ServletResponse#setCharacterEncoding(java.lang.String)</em>
<a name="158" href="#158">158</a> <em class="comment">     */</em>
<a name="159" href="#159">159</a>     <strong>public</strong> <strong>void</strong> setCharacterEncoding(String characterEncoding) {
<a name="160" href="#160">160</a>         <strong>this</strong>.characterEncoding = characterEncoding;
<a name="161" href="#161">161</a>     }
<a name="162" href="#162">162</a> 
<a name="163" href="#163">163</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="164" href="#164">164</a> <em class="comment">     * @see javax.servlet.ServletResponse#getCharacterEncoding()</em>
<a name="165" href="#165">165</a> <em class="comment">     */</em>
<a name="166" href="#166">166</a>     <strong>public</strong> String getCharacterEncoding() {
<a name="167" href="#167">167</a>         <strong>return</strong> <strong>this</strong>.characterEncoding;
<a name="168" href="#168">168</a>     }
<a name="169" href="#169">169</a> 
<a name="170" href="#170">170</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="171" href="#171">171</a> <em class="comment">     * @see javax.servlet.ServletResponse#getOutputStream()</em>
<a name="172" href="#172">172</a> <em class="comment">     */</em>
<a name="173" href="#173">173</a>     <strong>public</strong> ServletOutputStream getOutputStream() {
<a name="174" href="#174">174</a>         <strong>if</strong> (! <strong>this</strong>.outputStreamAccessAllowed) {
<a name="175" href="#175">175</a>             <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"OutputStream access not allowed"</span>);
<a name="176" href="#176">176</a>         }
<a name="177" href="#177">177</a>         <strong>this</strong>.writerAccessAllowed = false;
<a name="178" href="#178">178</a>         <strong>this</strong>.contentAccessed = <strong>true</strong>;
<a name="179" href="#179">179</a>         <strong>return</strong> <strong>this</strong>.outputStream;
<a name="180" href="#180">180</a>     }
<a name="181" href="#181">181</a> 
<a name="182" href="#182">182</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="183" href="#183">183</a> <em class="comment">     * @see javax.servlet.ServletResponse#getWriter()</em>
<a name="184" href="#184">184</a> <em class="comment">     */</em>
<a name="185" href="#185">185</a>     <strong>public</strong> PrintWriter getWriter() throws UnsupportedEncodingException {
<a name="186" href="#186">186</a>         <strong>if</strong> (! <strong>this</strong>.writerAccessAllowed) {
<a name="187" href="#187">187</a>             <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Writer access not allowed"</span>);
<a name="188" href="#188">188</a>         }
<a name="189" href="#189">189</a>         <strong>this</strong>.outputStreamAccessAllowed = false;
<a name="190" href="#190">190</a>         <strong>if</strong> (<strong>this</strong>.writer == <strong>null</strong>) {
<a name="191" href="#191">191</a>             OutputStreamWriter targetWriter = (<strong>this</strong>.characterEncoding != <strong>null</strong> ?
<a name="192" href="#192">192</a>                     <strong>new</strong> OutputStreamWriter(<strong>this</strong>.content, <strong>this</strong>.characterEncoding) : <strong>new</strong> OutputStreamWriter(<strong>this</strong>.content));
<a name="193" href="#193">193</a>             <strong>this</strong>.writer = <strong>new</strong> PrintWriter(targetWriter);
<a name="194" href="#194">194</a>         }
<a name="195" href="#195">195</a>         <strong>this</strong>.contentAccessed = <strong>true</strong>;
<a name="196" href="#196">196</a>         <strong>return</strong> <strong>this</strong>.writer;
<a name="197" href="#197">197</a>     }
<a name="198" href="#198">198</a> 
<a name="199" href="#199">199</a>     <em>/**<em>*</em></em>
<a name="200" href="#200">200</a> <em>     * @return the content as a byte array OR empty array if there is no content</em>
<a name="201" href="#201">201</a> <em>     */</em>
<a name="202" href="#202">202</a>     <strong>public</strong> byte[] getContentAsByteArray() {
<a name="203" href="#203">203</a>         <strong>if</strong> (! <strong>this</strong>.contentAccessed) {
<a name="204" href="#204">204</a>             <strong>return</strong> <strong>new</strong> byte[] {};
<a name="205" href="#205">205</a>         }
<a name="206" href="#206">206</a>         flushBuffer();
<a name="207" href="#207">207</a>         <strong>return</strong> <strong>this</strong>.content.toByteArray();
<a name="208" href="#208">208</a>     }
<a name="209" href="#209">209</a> 
<a name="210" href="#210">210</a>     <em>/**<em>*</em></em>
<a name="211" href="#211">211</a> <em>     * @return a string representing the content of this response OR "" if there is no content</em>
<a name="212" href="#212">212</a> <em>     * @throws RuntimeException if the encoding fails and the content cannot be retrieved</em>
<a name="213" href="#213">213</a> <em>     */</em>
<a name="214" href="#214">214</a>     <strong>public</strong> String getContentAsString() {
<a name="215" href="#215">215</a>         <strong>if</strong> (! <strong>this</strong>.contentAccessed) {
<a name="216" href="#216">216</a>             <strong>return</strong> <span class="string">""</span>;
<a name="217" href="#217">217</a>         }
<a name="218" href="#218">218</a>         flushBuffer();
<a name="219" href="#219">219</a>         <strong>try</strong> {
<a name="220" href="#220">220</a>             String content = (<strong>this</strong>.characterEncoding != <strong>null</strong>) ? <strong>this</strong>.content.toString(<strong>this</strong>.characterEncoding) : <strong>this</strong>.content.toString();
<a name="221" href="#221">221</a>             <strong>return</strong> content;
<a name="222" href="#222">222</a>         } <strong>catch</strong> (UnsupportedEncodingException e) {
<a name="223" href="#223">223</a>             <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Failure during encoding of the string in this response: "</span> + <strong>this</strong>.characterEncoding + <span class="string">":"</span> + e.getMessage(), e);
<a name="224" href="#224">224</a>         }
<a name="225" href="#225">225</a>     }
<a name="226" href="#226">226</a> 
<a name="227" href="#227">227</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="228" href="#228">228</a> <em class="comment">     * @see javax.servlet.ServletResponse#setContentLength(int)</em>
<a name="229" href="#229">229</a> <em class="comment">     */</em>
<a name="230" href="#230">230</a>     <strong>public</strong> <strong>void</strong> setContentLength(<strong>int</strong> contentLength) {
<a name="231" href="#231">231</a>         <strong>this</strong>.contentLength = contentLength;
<a name="232" href="#232">232</a>     }
<a name="233" href="#233">233</a> 
<a name="234" href="#234">234</a>     <strong>public</strong> <strong>int</strong> getContentLength() {
<a name="235" href="#235">235</a>         <strong>return</strong> <strong>this</strong>.contentLength;
<a name="236" href="#236">236</a>     }
<a name="237" href="#237">237</a> 
<a name="238" href="#238">238</a>     <strong>public</strong> <strong>void</strong> setContentType(String contentType) {
<a name="239" href="#239">239</a>         <strong>this</strong>.contentType = contentType;
<a name="240" href="#240">240</a>         <strong>if</strong> (contentType != <strong>null</strong>) {
<a name="241" href="#241">241</a>             <strong>int</strong> charsetIndex = contentType.toLowerCase().indexOf(CHARSET_PREFIX);
<a name="242" href="#242">242</a>             <strong>if</strong> (charsetIndex != -1) {
<a name="243" href="#243">243</a>                 String encoding = contentType.substring(charsetIndex + CHARSET_PREFIX.length());
<a name="244" href="#244">244</a>                 setCharacterEncoding(encoding);
<a name="245" href="#245">245</a>             }
<a name="246" href="#246">246</a>         }
<a name="247" href="#247">247</a>     }
<a name="248" href="#248">248</a> 
<a name="249" href="#249">249</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="250" href="#250">250</a> <em class="comment">     * @see javax.servlet.ServletResponse#getContentType()</em>
<a name="251" href="#251">251</a> <em class="comment">     */</em>
<a name="252" href="#252">252</a>     <strong>public</strong> String getContentType() {
<a name="253" href="#253">253</a>         <strong>return</strong> <strong>this</strong>.contentType;
<a name="254" href="#254">254</a>     }
<a name="255" href="#255">255</a> 
<a name="256" href="#256">256</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="257" href="#257">257</a> <em class="comment">     * @see javax.servlet.ServletResponse#setBufferSize(int)</em>
<a name="258" href="#258">258</a> <em class="comment">     */</em>
<a name="259" href="#259">259</a>     <strong>public</strong> <strong>void</strong> setBufferSize(<strong>int</strong> bufferSize) {
<a name="260" href="#260">260</a>         <strong>this</strong>.bufferSize = bufferSize;
<a name="261" href="#261">261</a>     }
<a name="262" href="#262">262</a> 
<a name="263" href="#263">263</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="264" href="#264">264</a> <em class="comment">     * @see javax.servlet.ServletResponse#getBufferSize()</em>
<a name="265" href="#265">265</a> <em class="comment">     */</em>
<a name="266" href="#266">266</a>     <strong>public</strong> <strong>int</strong> getBufferSize() {
<a name="267" href="#267">267</a>         <strong>return</strong> <strong>this</strong>.bufferSize;
<a name="268" href="#268">268</a>     }
<a name="269" href="#269">269</a> 
<a name="270" href="#270">270</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="271" href="#271">271</a> <em class="comment">     * @see javax.servlet.ServletResponse#flushBuffer()</em>
<a name="272" href="#272">272</a> <em class="comment">     */</em>
<a name="273" href="#273">273</a>     <strong>public</strong> <strong>void</strong> flushBuffer() {
<a name="274" href="#274">274</a>         setCommitted(<strong>true</strong>);
<a name="275" href="#275">275</a>         <strong>if</strong> (<strong>this</strong>.writer != <strong>null</strong>) {
<a name="276" href="#276">276</a>             <strong>this</strong>.writer.flush();
<a name="277" href="#277">277</a>         }
<a name="278" href="#278">278</a>         <strong>try</strong> {
<a name="279" href="#279">279</a>             <strong>this</strong>.outputStream.flush();
<a name="280" href="#280">280</a>         } <strong>catch</strong> (IOException e) {
<a name="281" href="#281">281</a>             <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Failed to flush the outputstream buffer"</span>);
<a name="282" href="#282">282</a>         }
<a name="283" href="#283">283</a>     }
<a name="284" href="#284">284</a> 
<a name="285" href="#285">285</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="286" href="#286">286</a> <em class="comment">     * @see javax.servlet.ServletResponse#resetBuffer()</em>
<a name="287" href="#287">287</a> <em class="comment">     */</em>
<a name="288" href="#288">288</a>     <strong>public</strong> <strong>void</strong> resetBuffer() {
<a name="289" href="#289">289</a>         <strong>if</strong> (isCommitted()) {
<a name="290" href="#290">290</a>             <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Cannot reset buffer - response is already committed"</span>);
<a name="291" href="#291">291</a>         }
<a name="292" href="#292">292</a>         <strong>this</strong>.content.reset();
<a name="293" href="#293">293</a>         <strong>this</strong>.contentLength = 0;
<a name="294" href="#294">294</a>     }
<a name="295" href="#295">295</a> 
<a name="296" href="#296">296</a>     <strong>public</strong> <strong>void</strong> setCommitted(<strong>boolean</strong> committed) {
<a name="297" href="#297">297</a>         <strong>this</strong>.committed = committed;
<a name="298" href="#298">298</a>     }
<a name="299" href="#299">299</a> 
<a name="300" href="#300">300</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="301" href="#301">301</a> <em class="comment">     * @see javax.servlet.ServletResponse#isCommitted()</em>
<a name="302" href="#302">302</a> <em class="comment">     */</em>
<a name="303" href="#303">303</a>     <strong>public</strong> <strong>boolean</strong> isCommitted() {
<a name="304" href="#304">304</a>         <strong>return</strong> <strong>this</strong>.committed;
<a name="305" href="#305">305</a>     }
<a name="306" href="#306">306</a> 
<a name="307" href="#307">307</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="308" href="#308">308</a> <em class="comment">     * @see javax.servlet.ServletResponse#reset()</em>
<a name="309" href="#309">309</a> <em class="comment">     */</em>
<a name="310" href="#310">310</a>     <strong>public</strong> <strong>void</strong> reset() {
<a name="311" href="#311">311</a>         resetBuffer();
<a name="312" href="#312">312</a>         <strong>this</strong>.characterEncoding = <strong>null</strong>;
<a name="313" href="#313">313</a>         <strong>this</strong>.contentLength = 0;
<a name="314" href="#314">314</a>         <strong>this</strong>.contentType = <strong>null</strong>;
<a name="315" href="#315">315</a>         <strong>this</strong>.locale = Locale.getDefault();
<a name="316" href="#316">316</a>         <strong>this</strong>.cookies.clear();
<a name="317" href="#317">317</a>         <strong>this</strong>.headers.clear();
<a name="318" href="#318">318</a>         <strong>this</strong>.status = HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
<a name="319" href="#319">319</a>         <strong>this</strong>.errorMessage = <strong>null</strong>;
<a name="320" href="#320">320</a>         <strong>this</strong>.forwardedUrl = <strong>null</strong>;
<a name="321" href="#321">321</a>         <strong>this</strong>.redirectedUrl = <strong>null</strong>;
<a name="322" href="#322">322</a>         <strong>this</strong>.contentAccessed = false;
<a name="323" href="#323">323</a>         <strong>this</strong>.outputStreamAccessAllowed = <strong>true</strong>;
<a name="324" href="#324">324</a>         <strong>this</strong>.writerAccessAllowed = <strong>true</strong>;
<a name="325" href="#325">325</a>         <strong>this</strong>.writer = <strong>null</strong>;
<a name="326" href="#326">326</a>     }
<a name="327" href="#327">327</a> 
<a name="328" href="#328">328</a>     <strong>public</strong> <strong>void</strong> setLocale(Locale locale) {
<a name="329" href="#329">329</a>         <strong>this</strong>.locale = locale;
<a name="330" href="#330">330</a>     }
<a name="331" href="#331">331</a> 
<a name="332" href="#332">332</a>     <strong>public</strong> Locale getLocale() {
<a name="333" href="#333">333</a>         <strong>return</strong> <strong>this</strong>.locale;
<a name="334" href="#334">334</a>     }
<a name="335" href="#335">335</a> 
<a name="336" href="#336">336</a> 
<a name="337" href="#337">337</a>     <em class="comment">//---------------------------------------------------------------------</em>
<a name="338" href="#338">338</a>     <em class="comment">// HttpServletResponse interface</em>
<a name="339" href="#339">339</a>     <em class="comment">//---------------------------------------------------------------------</em>
<a name="340" href="#340">340</a> 
<a name="341" href="#341">341</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="342" href="#342">342</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#addCookie(javax.servlet.http.Cookie)</em>
<a name="343" href="#343">343</a> <em class="comment">     */</em>
<a name="344" href="#344">344</a>     <strong>public</strong> <strong>void</strong> addCookie(Cookie cookie) {
<a name="345" href="#345">345</a>         <strong>if</strong> (cookie == <strong>null</strong>) {
<a name="346" href="#346">346</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cookie cannot be null"</span>);
<a name="347" href="#347">347</a>         }
<a name="348" href="#348">348</a>         <strong>this</strong>.cookies.add(cookie);
<a name="349" href="#349">349</a>     }
<a name="350" href="#350">350</a> 
<a name="351" href="#351">351</a>     <strong>public</strong> Cookie[] getCookies() {
<a name="352" href="#352">352</a>         <strong>return</strong> (Cookie[]) <strong>this</strong>.cookies.toArray(<strong>new</strong> Cookie[<strong>this</strong>.cookies.size()]);
<a name="353" href="#353">353</a>     }
<a name="354" href="#354">354</a> 
<a name="355" href="#355">355</a>     <strong>public</strong> Cookie getCookie(String name) {
<a name="356" href="#356">356</a>         <strong>if</strong> (name == <strong>null</strong>) {
<a name="357" href="#357">357</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cookie name cannot be null"</span>);
<a name="358" href="#358">358</a>         }
<a name="359" href="#359">359</a>         <strong>for</strong> (Iterator&lt;Cookie> it = <strong>this</strong>.cookies.iterator(); it.hasNext();) {
<a name="360" href="#360">360</a>             Cookie cookie = (Cookie) it.next();
<a name="361" href="#361">361</a>             <strong>if</strong> (name.equals(cookie.getName())) {
<a name="362" href="#362">362</a>                 <strong>return</strong> cookie;
<a name="363" href="#363">363</a>             }
<a name="364" href="#364">364</a>         }
<a name="365" href="#365">365</a>         <strong>return</strong> <strong>null</strong>;
<a name="366" href="#366">366</a>     }
<a name="367" href="#367">367</a> 
<a name="368" href="#368">368</a>     <em>/**<em>*</em></em>
<a name="369" href="#369">369</a> <em>     * The default implementation returns the given URL String as-is.</em>
<a name="370" href="#370">370</a> <em>     * &lt;p>Can be overridden in subclasses, appending a session id or the like.</em>
<a name="371" href="#371">371</a> <em>     */</em>
<a name="372" href="#372">372</a>     <strong>public</strong> String encodeURL(String url) {
<a name="373" href="#373">373</a>         <strong>return</strong> url;
<a name="374" href="#374">374</a>     }
<a name="375" href="#375">375</a> 
<a name="376" href="#376">376</a>     <em>/**<em>*</em></em>
<a name="377" href="#377">377</a> <em>     * The default implementation delegates to {@link #encodeURL},</em>
<a name="378" href="#378">378</a> <em>     * returning the given URL String as-is.</em>
<a name="379" href="#379">379</a> <em>     * &lt;p>Can be overridden in subclasses, appending a session id or the like</em>
<a name="380" href="#380">380</a> <em>     * in a redirect-specific fashion. For general URL encoding rules,</em>
<a name="381" href="#381">381</a> <em>     * override the common {@link #encodeURL} method instead, appyling</em>
<a name="382" href="#382">382</a> <em>     * to redirect URLs as well as to general URLs.</em>
<a name="383" href="#383">383</a> <em>     */</em>
<a name="384" href="#384">384</a>     <strong>public</strong> String encodeRedirectURL(String url) {
<a name="385" href="#385">385</a>         <strong>return</strong> encodeURL(url);
<a name="386" href="#386">386</a>     }
<a name="387" href="#387">387</a> 
<a name="388" href="#388">388</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="389" href="#389">389</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#encodeUrl(java.lang.String)</em>
<a name="390" href="#390">390</a> <em class="comment">     */</em>
<a name="391" href="#391">391</a>     <strong>public</strong> String encodeUrl(String url) {
<a name="392" href="#392">392</a>         <strong>return</strong> encodeURL(url);
<a name="393" href="#393">393</a>     }
<a name="394" href="#394">394</a> 
<a name="395" href="#395">395</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="396" href="#396">396</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#encodeRedirectUrl(java.lang.String)</em>
<a name="397" href="#397">397</a> <em class="comment">     */</em>
<a name="398" href="#398">398</a>     <strong>public</strong> String encodeRedirectUrl(String url) {
<a name="399" href="#399">399</a>         <strong>return</strong> encodeRedirectURL(url);
<a name="400" href="#400">400</a>     }
<a name="401" href="#401">401</a> 
<a name="402" href="#402">402</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="403" href="#403">403</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#sendError(int, java.lang.String)</em>
<a name="404" href="#404">404</a> <em class="comment">     */</em>
<a name="405" href="#405">405</a>     <strong>public</strong> <strong>void</strong> sendError(<strong>int</strong> status, String errorMessage) throws IOException {
<a name="406" href="#406">406</a>         <strong>if</strong> (isCommitted()) {
<a name="407" href="#407">407</a>             <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Cannot set error status - response is already committed"</span>);
<a name="408" href="#408">408</a>         }
<a name="409" href="#409">409</a>         <strong>this</strong>.status = status;
<a name="410" href="#410">410</a>         <strong>this</strong>.errorMessage = errorMessage;
<a name="411" href="#411">411</a>         setCommitted(<strong>true</strong>);
<a name="412" href="#412">412</a>     }
<a name="413" href="#413">413</a> 
<a name="414" href="#414">414</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="415" href="#415">415</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#sendError(int)</em>
<a name="416" href="#416">416</a> <em class="comment">     */</em>
<a name="417" href="#417">417</a>     <strong>public</strong> <strong>void</strong> sendError(<strong>int</strong> status) throws IOException {
<a name="418" href="#418">418</a>         <strong>if</strong> (isCommitted()) {
<a name="419" href="#419">419</a>             <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Cannot set error status - response is already committed"</span>);
<a name="420" href="#420">420</a>         }
<a name="421" href="#421">421</a>         <strong>this</strong>.status = status;
<a name="422" href="#422">422</a>         setCommitted(<strong>true</strong>);
<a name="423" href="#423">423</a>     }
<a name="424" href="#424">424</a> 
<a name="425" href="#425">425</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="426" href="#426">426</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#sendRedirect(java.lang.String)</em>
<a name="427" href="#427">427</a> <em class="comment">     */</em>
<a name="428" href="#428">428</a>     <strong>public</strong> <strong>void</strong> sendRedirect(String url) throws IOException {
<a name="429" href="#429">429</a>         <strong>if</strong> (isCommitted()) {
<a name="430" href="#430">430</a>             <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Cannot send redirect - response is already committed"</span>);
<a name="431" href="#431">431</a>         }
<a name="432" href="#432">432</a>         <strong>if</strong> (url == <strong>null</strong>) {
<a name="433" href="#433">433</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"url cannot be null"</span>);
<a name="434" href="#434">434</a>         }
<a name="435" href="#435">435</a>         <strong>this</strong>.redirectedUrl = url;
<a name="436" href="#436">436</a>         setCommitted(<strong>true</strong>);
<a name="437" href="#437">437</a>     }
<a name="438" href="#438">438</a> 
<a name="439" href="#439">439</a>     <em class="comment">// these allow us to know if this response was forwarded</em>
<a name="440" href="#440">440</a> 
<a name="441" href="#441">441</a>     <em>/**<em>*</em></em>
<a name="442" href="#442">442</a> <em>     * @return true if this response was redirected</em>
<a name="443" href="#443">443</a> <em>     */</em>
<a name="444" href="#444">444</a>     <strong>public</strong> <strong>boolean</strong> isRedirected() {
<a name="445" href="#445">445</a>         <strong>boolean</strong> redirected = false;
<a name="446" href="#446">446</a>         <strong>if</strong> (<strong>this</strong>.getForwardedUrl() != <strong>null</strong>
<a name="447" href="#447">447</a>                 || <strong>this</strong>.getStatus() == HttpServletResponse.SC_FOUND
<a name="448" href="#448">448</a>                 || <strong>this</strong>.getStatus() == HttpServletResponse.SC_MOVED_PERMANENTLY
<a name="449" href="#449">449</a>                 || <strong>this</strong>.getStatus() == HttpServletResponse.SC_SEE_OTHER
<a name="450" href="#450">450</a>                 || <strong>this</strong>.getStatus() == HttpServletResponse.SC_TEMPORARY_REDIRECT) {
<a name="451" href="#451">451</a>             redirected = <strong>true</strong>;
<a name="452" href="#452">452</a>         }
<a name="453" href="#453">453</a>         <strong>return</strong> redirected;
<a name="454" href="#454">454</a>     }
<a name="455" href="#455">455</a> 
<a name="456" href="#456">456</a>     <em>/**<em>*</em></em>
<a name="457" href="#457">457</a> <em>     * @return the URL this response was forwarded or redirected to OR null if not redirected</em>
<a name="458" href="#458">458</a> <em>     */</em>
<a name="459" href="#459">459</a>     <strong>public</strong> String getRedirectedUrl() {
<a name="460" href="#460">460</a>         String url = <strong>this</strong>.redirectedUrl;
<a name="461" href="#461">461</a>         <strong>if</strong> (url == <strong>null</strong>) {
<a name="462" href="#462">462</a>             <strong>if</strong> ( isRedirected() ) {
<a name="463" href="#463">463</a>                 url = <strong>this</strong>.getForwardedUrl();
<a name="464" href="#464">464</a>                 <strong>if</strong> (url == <strong>null</strong>) {
<a name="465" href="#465">465</a>                     url = <strong>this</strong>.getIncludedUrl();
<a name="466" href="#466">466</a>                 }
<a name="467" href="#467">467</a>                 <strong>if</strong> (<strong>this</strong>.getStatus() == HttpServletResponse.SC_MOVED_PERMANENTLY
<a name="468" href="#468">468</a>                     || <strong>this</strong>.getStatus() == HttpServletResponse.SC_SEE_OTHER
<a name="469" href="#469">469</a>                     || <strong>this</strong>.getStatus() == HttpServletResponse.SC_TEMPORARY_REDIRECT) {
<a name="470" href="#470">470</a>                     <em class="comment">// get the location</em>
<a name="471" href="#471">471</a>                     String newLocation = <strong>this</strong>.getHeader(<span class="string">"Location"</span>);
<a name="472" href="#472">472</a>                     <strong>if</strong> (newLocation == <strong>null</strong>) {
<a name="473" href="#473">473</a>                         newLocation = <strong>this</strong>.getHeader(<span class="string">"location"</span>);
<a name="474" href="#474">474</a>                     }
<a name="475" href="#475">475</a>                     <strong>if</strong> (newLocation != <strong>null</strong>) {
<a name="476" href="#476">476</a>                         url = newLocation;
<a name="477" href="#477">477</a>                     }
<a name="478" href="#478">478</a>                 }
<a name="479" href="#479">479</a>             }
<a name="480" href="#480">480</a>         }
<a name="481" href="#481">481</a>         <strong>return</strong> url;
<a name="482" href="#482">482</a>     }
<a name="483" href="#483">483</a> 
<a name="484" href="#484">484</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="485" href="#485">485</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#setDateHeader(java.lang.String, long)</em>
<a name="486" href="#486">486</a> <em class="comment">     */</em>
<a name="487" href="#487">487</a>     <strong>public</strong> <strong>void</strong> setDateHeader(String name, <strong>long</strong> value) {
<a name="488" href="#488">488</a>         setHeaderValue(name, value+<span class="string">""</span>);
<a name="489" href="#489">489</a>     }
<a name="490" href="#490">490</a> 
<a name="491" href="#491">491</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="492" href="#492">492</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#addDateHeader(java.lang.String, long)</em>
<a name="493" href="#493">493</a> <em class="comment">     */</em>
<a name="494" href="#494">494</a>     <strong>public</strong> <strong>void</strong> addDateHeader(String name, <strong>long</strong> value) {
<a name="495" href="#495">495</a>         addHeaderValue(name, value+<span class="string">""</span>);
<a name="496" href="#496">496</a>     }
<a name="497" href="#497">497</a> 
<a name="498" href="#498">498</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="499" href="#499">499</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#setHeader(java.lang.String, java.lang.String)</em>
<a name="500" href="#500">500</a> <em class="comment">     */</em>
<a name="501" href="#501">501</a>     <strong>public</strong> <strong>void</strong> setHeader(String name, String value) {
<a name="502" href="#502">502</a>         setHeaderValue(name, value);
<a name="503" href="#503">503</a>     }
<a name="504" href="#504">504</a> 
<a name="505" href="#505">505</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="506" href="#506">506</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#addHeader(java.lang.String, java.lang.String)</em>
<a name="507" href="#507">507</a> <em class="comment">     */</em>
<a name="508" href="#508">508</a>     <strong>public</strong> <strong>void</strong> addHeader(String name, String value) {
<a name="509" href="#509">509</a>         addHeaderValue(name, value);
<a name="510" href="#510">510</a>     }
<a name="511" href="#511">511</a> 
<a name="512" href="#512">512</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="513" href="#513">513</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#setIntHeader(java.lang.String, int)</em>
<a name="514" href="#514">514</a> <em class="comment">     */</em>
<a name="515" href="#515">515</a>     <strong>public</strong> <strong>void</strong> setIntHeader(String name, <strong>int</strong> value) {
<a name="516" href="#516">516</a>         setHeaderValue(name, value+<span class="string">""</span>);
<a name="517" href="#517">517</a>     }
<a name="518" href="#518">518</a> 
<a name="519" href="#519">519</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="520" href="#520">520</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#addIntHeader(java.lang.String, int)</em>
<a name="521" href="#521">521</a> <em class="comment">     */</em>
<a name="522" href="#522">522</a>     <strong>public</strong> <strong>void</strong> addIntHeader(String name, <strong>int</strong> value) {
<a name="523" href="#523">523</a>         addHeaderValue(name, value+<span class="string">""</span>);
<a name="524" href="#524">524</a>     }
<a name="525" href="#525">525</a> 
<a name="526" href="#526">526</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="527" href="#527">527</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#containsHeader(java.lang.String)</em>
<a name="528" href="#528">528</a> <em class="comment">     */</em>
<a name="529" href="#529">529</a>     <strong>public</strong> <strong>boolean</strong> containsHeader(String name) {
<a name="530" href="#530">530</a>         <strong>boolean</strong> found = false;
<a name="531" href="#531">531</a>         <strong>if</strong> (name != <strong>null</strong>) {
<a name="532" href="#532">532</a>             found = <strong>this</strong>.headers.containsKey(name);
<a name="533" href="#533">533</a>         }
<a name="534" href="#534">534</a>         <strong>return</strong> found;
<a name="535" href="#535">535</a>     }
<a name="536" href="#536">536</a> 
<a name="537" href="#537">537</a> 
<a name="538" href="#538">538</a>     <em class="comment">// HEADER handling methods</em>
<a name="539" href="#539">539</a> 
<a name="540" href="#540">540</a>     <em>/**<em>*</em></em>
<a name="541" href="#541">541</a> <em>     * Return the primary value for the given header, if any,</em>
<a name="542" href="#542">542</a> <em>     * Will return the first value in case of multiple values</em>
<a name="543" href="#543">543</a> <em>     * </em>
<a name="544" href="#544">544</a> <em>     * @param name the name of the header</em>
<a name="545" href="#545">545</a> <em>     * @return the first value in this header OR null if there is no header by this name</em>
<a name="546" href="#546">546</a> <em>     */</em>
<a name="547" href="#547">547</a>     <strong>public</strong> String getHeader(String name) {
<a name="548" href="#548">548</a>         <strong>if</strong> (name == <strong>null</strong> || <span class="string">""</span>.equals(name)) {
<a name="549" href="#549">549</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"name cannot be null"</span>);
<a name="550" href="#550">550</a>         }
<a name="551" href="#551">551</a>         String value = <strong>null</strong>;
<a name="552" href="#552">552</a>         <strong>if</strong> (<strong>this</strong>.headers.containsKey(name)) {
<a name="553" href="#553">553</a>             Vector&lt;String> v = <strong>this</strong>.headers.get(name);
<a name="554" href="#554">554</a>             <strong>if</strong> (v == <strong>null</strong>) {
<a name="555" href="#555">555</a>                 <strong>this</strong>.headers.remove(name);
<a name="556" href="#556">556</a>             } <strong>else</strong> {
<a name="557" href="#557">557</a>                 <strong>if</strong> (v.size() > 0) {
<a name="558" href="#558">558</a>                     value = v.get(0);
<a name="559" href="#559">559</a>                 }
<a name="560" href="#560">560</a>             }
<a name="561" href="#561">561</a>         }
<a name="562" href="#562">562</a>         <strong>return</strong> value;
<a name="563" href="#563">563</a>     }
<a name="564" href="#564">564</a> 
<a name="565" href="#565">565</a>     <em>/**<em>*</em></em>
<a name="566" href="#566">566</a> <em>     * Return the primary value for the given header, if any,</em>
<a name="567" href="#567">567</a> <em>     * Will return the first value in case of multiple values</em>
<a name="568" href="#568">568</a> <em>     * </em>
<a name="569" href="#569">569</a> <em>     * @param name the name of the header</em>
<a name="570" href="#570">570</a> <em>     * @return the list of all values in this header OR null if there are none</em>
<a name="571" href="#571">571</a> <em>     */</em>
<a name="572" href="#572">572</a>     <strong>public</strong> List&lt;String> getHeaders(String name) {
<a name="573" href="#573">573</a>         <strong>if</strong> (name == <strong>null</strong> || <span class="string">""</span>.equals(name)) {
<a name="574" href="#574">574</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"name cannot be null"</span>);
<a name="575" href="#575">575</a>         }
<a name="576" href="#576">576</a>         List&lt;String> values;
<a name="577" href="#577">577</a>         <strong>if</strong> (<strong>this</strong>.headers.containsKey(name)) {
<a name="578" href="#578">578</a>             values = <strong>this</strong>.headers.get(name);
<a name="579" href="#579">579</a>         } <strong>else</strong> {
<a name="580" href="#580">580</a>             values = <strong>new</strong> ArrayList&lt;String>();
<a name="581" href="#581">581</a>         }
<a name="582" href="#582">582</a>         <strong>return</strong> values;
<a name="583" href="#583">583</a>     }
<a name="584" href="#584">584</a> 
<a name="585" href="#585">585</a>     <em>/**<em>*</em></em>
<a name="586" href="#586">586</a> <em>     * Return the names of all specified headers as a Set of Strings.</em>
<a name="587" href="#587">587</a> <em>     * @return the &lt;code>Set&lt;/code> of header name &lt;code>Strings&lt;/code>, or an empty &lt;code>Set&lt;/code> if none</em>
<a name="588" href="#588">588</a> <em>     */</em>
<a name="589" href="#589">589</a>     <strong>public</strong> Set getHeaderNames() {
<a name="590" href="#590">590</a>         <strong>return</strong> <strong>this</strong>.headers.keySet();
<a name="591" href="#591">591</a>     }
<a name="592" href="#592">592</a> 
<a name="593" href="#593">593</a>     <em>/**<em>*</em></em>
<a name="594" href="#594">594</a> <em>     * Get all headers in this response</em>
<a name="595" href="#595">595</a> <em>     * @return all headers as a map of string (header name) -> List(String) (header values)</em>
<a name="596" href="#596">596</a> <em>     */</em>
<a name="597" href="#597">597</a>     <strong>public</strong> Map&lt;String, Vector&lt;String>> getActualHeaders() {
<a name="598" href="#598">598</a>         <strong>return</strong> Collections.unmodifiableMap(<strong>this</strong>.headers);
<a name="599" href="#599">599</a>     }
<a name="600" href="#600">600</a> 
<a name="601" href="#601">601</a>     <em>/**<em>*</em></em>
<a name="602" href="#602">602</a> <em>     * Get all headers in this response as a map of string (name) -> String[] (values)</em>
<a name="603" href="#603">603</a> <em>     * @return all headers in this response as a map of string (name) -> String[] (values)</em>
<a name="604" href="#604">604</a> <em>     */</em>
<a name="605" href="#605">605</a>     <strong>public</strong> Map&lt;String, String[]> getHeaders() {
<a name="606" href="#606">606</a>         Map&lt;String, String[]> m = <strong>new</strong> ArrayOrderedMap&lt;String, String[]>();
<a name="607" href="#607">607</a>         <strong>if</strong> (<strong>this</strong>.headers != <strong>null</strong> &amp;&amp; <strong>this</strong>.headers.size() > 0) {
<a name="608" href="#608">608</a>             Set&lt;String> keysSet = <strong>this</strong>.headers.keySet();
<a name="609" href="#609">609</a>             ArrayList&lt;String> keysList = <strong>new</strong> ArrayList&lt;String>(keysSet);
<a name="610" href="#610">610</a>             Collections.sort(keysList);
<a name="611" href="#611">611</a>             <strong>for</strong> (String key : keysList) {
<a name="612" href="#612">612</a>                 Vector&lt;String> values = <strong>this</strong>.headers.get(key);
<a name="613" href="#613">613</a>                 <strong>if</strong> (values != <strong>null</strong> &amp;&amp; values.size() > 0) {
<a name="614" href="#614">614</a>                     String[] value = values.toArray(<strong>new</strong> String[values.size()]);
<a name="615" href="#615">615</a>                     m.put(key, value);
<a name="616" href="#616">616</a>                 }
<a name="617" href="#617">617</a>             }
<a name="618" href="#618">618</a>         }
<a name="619" href="#619">619</a>         <strong>return</strong> m;
<a name="620" href="#620">620</a>     }
<a name="621" href="#621">621</a> 
<a name="622" href="#622">622</a>     <em>/**<em>*</em></em>
<a name="623" href="#623">623</a> <em>     * Delete a header and all values by name</em>
<a name="624" href="#624">624</a> <em>     * @param name the name key of the header</em>
<a name="625" href="#625">625</a> <em>     */</em>
<a name="626" href="#626">626</a>     <strong>public</strong> <strong>void</strong> removeHeader(String name) {
<a name="627" href="#627">627</a>         <strong>if</strong> (name == <strong>null</strong> || <span class="string">""</span>.equals(name)) {
<a name="628" href="#628">628</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"name ("</span>+name+<span class="string">") must not be null"</span>);
<a name="629" href="#629">629</a>         }
<a name="630" href="#630">630</a>         <strong>this</strong>.headers.remove(name);
<a name="631" href="#631">631</a>     }
<a name="632" href="#632">632</a> 
<a name="633" href="#633">633</a>     <strong>public</strong> <strong>void</strong> clearHeaders() {
<a name="634" href="#634">634</a>         <strong>this</strong>.headers.clear();
<a name="635" href="#635">635</a>     }
<a name="636" href="#636">636</a> 
<a name="637" href="#637">637</a>     <strong>private</strong> <strong>void</strong> setHeaderValue(String name, String value) {
<a name="638" href="#638">638</a>         doAddHeaderValue(name, value, <strong>true</strong>);
<a name="639" href="#639">639</a>     }
<a name="640" href="#640">640</a> 
<a name="641" href="#641">641</a>     <strong>private</strong> <strong>void</strong> addHeaderValue(String name, String value) {
<a name="642" href="#642">642</a>         doAddHeaderValue(name, value, false);
<a name="643" href="#643">643</a>     }
<a name="644" href="#644">644</a> 
<a name="645" href="#645">645</a>     <strong>private</strong> <strong>void</strong> doAddHeaderValue(String name, String value, <strong>boolean</strong> replace) {
<a name="646" href="#646">646</a>         <strong>if</strong> (name == <strong>null</strong> || <span class="string">""</span>.equals(name)
<a name="647" href="#647">647</a>                 || value == <strong>null</strong>) {
<a name="648" href="#648">648</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"name ("</span>+name+<span class="string">") and value ("</span>+value+<span class="string">") must not be null"</span>);
<a name="649" href="#649">649</a>         }
<a name="650" href="#650">650</a>         <strong>if</strong> (replace) {
<a name="651" href="#651">651</a>             Vector&lt;String> v = <strong>new</strong> Vector&lt;String>();
<a name="652" href="#652">652</a>             v.add(value);
<a name="653" href="#653">653</a>             <strong>this</strong>.headers.put(name, v);
<a name="654" href="#654">654</a>         } <strong>else</strong> {
<a name="655" href="#655">655</a>             <strong>if</strong> (<strong>this</strong>.headers.containsKey(name)) {
<a name="656" href="#656">656</a>                 Vector&lt;String> v = <strong>this</strong>.headers.get(name);
<a name="657" href="#657">657</a>                 <strong>if</strong> (v == <strong>null</strong>) {
<a name="658" href="#658">658</a>                     v = <strong>new</strong> Vector&lt;String>();
<a name="659" href="#659">659</a>                     <strong>this</strong>.headers.put(name, v);
<a name="660" href="#660">660</a>                 }
<a name="661" href="#661">661</a>                 v.add(value);
<a name="662" href="#662">662</a>             } <strong>else</strong> {
<a name="663" href="#663">663</a>                 Vector&lt;String> v = <strong>new</strong> Vector&lt;String>();
<a name="664" href="#664">664</a>                 v.add(value);
<a name="665" href="#665">665</a>                 <strong>this</strong>.headers.put(name, v);
<a name="666" href="#666">666</a>             }
<a name="667" href="#667">667</a>         }
<a name="668" href="#668">668</a>     }
<a name="669" href="#669">669</a> 
<a name="670" href="#670">670</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="671" href="#671">671</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#setStatus(int)</em>
<a name="672" href="#672">672</a> <em class="comment">     */</em>
<a name="673" href="#673">673</a>     <strong>public</strong> <strong>void</strong> setStatus(<strong>int</strong> status) {
<a name="674" href="#674">674</a>         <strong>this</strong>.status = status;
<a name="675" href="#675">675</a>     }
<a name="676" href="#676">676</a> 
<a name="677" href="#677">677</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="678" href="#678">678</a> <em class="comment">     * @see javax.servlet.http.HttpServletResponse#setStatus(int, java.lang.String)</em>
<a name="679" href="#679">679</a> <em class="comment">     */</em>
<a name="680" href="#680">680</a>     <strong>public</strong> <strong>void</strong> setStatus(<strong>int</strong> status, String errorMessage) {
<a name="681" href="#681">681</a>         <strong>this</strong>.status = status;
<a name="682" href="#682">682</a>         <strong>this</strong>.errorMessage = errorMessage;
<a name="683" href="#683">683</a>     }
<a name="684" href="#684">684</a> 
<a name="685" href="#685">685</a>     <strong>public</strong> <strong>int</strong> getStatus() {
<a name="686" href="#686">686</a>         <strong>return</strong> <strong>this</strong>.status;
<a name="687" href="#687">687</a>     }
<a name="688" href="#688">688</a> 
<a name="689" href="#689">689</a>     <strong>public</strong> String getErrorMessage() {
<a name="690" href="#690">690</a>         <strong>return</strong> <strong>this</strong>.errorMessage;
<a name="691" href="#691">691</a>     }
<a name="692" href="#692">692</a> 
<a name="693" href="#693">693</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

